Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: add migration to create PA role #2181

Merged
merged 2 commits into from
Jul 30, 2024
Merged

Conversation

hamzawaleed01
Copy link
Member

@hamzawaleed01 hamzawaleed01 commented Jul 25, 2024

Merge checklist:

  • Any new requirements are in the right place (do not manually modify the requirements/*.txt files)
    • base.in if needed in production but edx-platform doesn't install it
    • test-master.in if edx-platform pins it, with a matching version
    • make upgrade && make requirements have been run to regenerate requirements
  • make static has been run to update webpack bundling if any static content was updated
  • ./manage.py makemigrations has been run
    • Checkout the Database Migration Confluence page for helpful tips on creating migrations.
    • Note: This must be run if you modified any models.
      • It may or may not make a migration depending on exactly what you modified, but it should still be run.
    • This should be run from either a venv with all the lms/edx-enterprise requirements installed or if you checked out edx-enterprise into the src directory used by lms, you can run this command through an lms shell.
      • It would be ./manage.py lms makemigrations in the shell.
  • Version bumped
  • Changelog record added
  • Translations updated (see docs/internationalization.rst but also this isn't blocking for merge atm)

Post merge:

  • Tag pushed and a new version released
    • Note: Assets will be added automatically. You just need to provide a tag (should match your version number) and title and description.
  • After versioned build finishes in GitHub Actions, verify version has been pushed to PyPI
    • Each step in the release build has a condition flag that checks if the rest of the steps are done and if so will deploy to PyPi.
      (so basically once your build finishes, after maybe a minute you should see the new version in PyPi automatically (on refresh))
  • PR created in edx-platform to upgrade dependencies (including edx-enterprise)
    • Trigger the 'Upgrade one Python dependency' action against master in edx-platform with new version number to generate version bump PR
    • This must be done after the version is visible in PyPi as make upgrade in edx-platform will look for the latest version in PyPi.
    • Note: the edx-enterprise constraint in edx-platform must also be bumped to the latest version in PyPi.

Copy link
Member

@zamanafzal zamanafzal left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

Copy link
Member

@sameenfatima78 sameenfatima78 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

A couple of suggestions:

  1. We need to add tests for this new role in:
    https://github.com/openedx/edx-enterprise/blob/master/tests/test_roles_api.py

  2. Make sure we are validating all tests in this file on this newly added role:
    https://github.com/openedx/edx-enterprise/blob/master/tests/test_models.py#L2323

  3. Update this file to add helper methods for this new role:
    https://github.com/openedx/edx-enterprise/blob/master/enterprise/roles_api.py

  4. Can we also look at the usage of get_or_create_system_wide_role in code to see whether we should be doing this via migration or this utility?

@hamzawaleed01 hamzawaleed01 force-pushed the ENT-9200/new-role-in-lms branch 4 times, most recently from 414e637 to 7906511 Compare July 29, 2024 06:57
@hamzawaleed01
Copy link
Member Author

hamzawaleed01 commented Jul 29, 2024

@sameenfatima78

  1. Done

  2. Added necessary tests

  3. Done

  4. It's being used in roles_api only. Added my util function also there.

@hamzawaleed01 hamzawaleed01 merged commit d192a3a into master Jul 30, 2024
9 checks passed
@hamzawaleed01 hamzawaleed01 deleted the ENT-9200/new-role-in-lms branch July 30, 2024 09:24
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants